pp108 : GetXMLObject (XML Store)

GetXMLObject (XML Store)

This Web service operation is used to retrieve a specific object from the XML Store, based on a key.

SOAP Request

<GetXMLObject xmlns="http://schemas.cordys.com/1.0/xmlstore">
    <key>/Cordys/WCP/Menu/Cordys/wcp/demo</key>
</GetXMLObject>

Request Parameters

Parameter

Description

key

The key based on which the object from the XML Store has to be retrieved. It must be the path from the collection folder to the location of object in XML Store.

SOAP Response

<GetXMLObjectResponse xmlns="http://schemas.cordys.com/1.0/xmlstore">
    <tuple key="/Cordys/WCP/Menu/Cordys/wcp/demo"
        lastModified="1026187296933" level="organization" name="demo">
        <old>
            <menu>
                <Application xmlns="http://schemas.cordys.com/1.0/xmlstore">
                    <description>Demos and Examples</description>
                    <caption>Demos and Examples</caption>
                    <Application>
                        <description>Northwind Demo Application1</description>
                        <caption>Northwind</caption>
                        <id>NorthwindDemo</id>
                        <url>/cordys/wcp/northwind/explorer.htm</url>
                        <frame>left</frame>
                    </Application>
                </Application>
            </menu>
        </old>
    </tuple>
</GetXMLObjectResponse>

Note:
By default, the XML Object is searched in the current organization. If not found, it is then searched in ISV folder.If the user wants a particular version (user/isv/organization) of XML Object to be retrieved, then the version can be specified in the version attribute of <key>.

The response in the case of a read-only XML Object is:

<GetXMLObjectResponse xmlns="http://schemas.cordys.com/1.0/xmlstore">
    <tuple key="/Cordys/WCP/Menu/Cordys/wcp/demo"
        lastModified="1026187296933" level="organization" name="demo" readOnly="true">
        <old>
            <menu>
                <Application xmlns="http://schemas.cordys.com/1.0/xmlstore">
                    <description>Demos and Examples</description>
                    <caption>Demos and Examples</caption>
                    <Application>
                        <description>Northwind Demo Application1</description>
                        <caption>Northwind</caption>
                        <id>NorthwindDemo</id>
                        <url>/cordys/wcp/northwind/explorer.htm</url>
                        <frame>left</frame>
                    </Application>
                </Application>
            </menu>
        </old>
    </tuple>
</GetXMLObjectResponse>